3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for MediaWiki.
6 # Some placeholders have been added for MediaWiki usage:
7 # OUTPUT_DIRECTORY = {{OUTPUT_DIRECTORY}}
8 # CURRENT_VERSION = {{CURRENT_VERSION}}
9 # STRIP_FROM_PATH = {{STRIP_FROM_PATH}}
12 # To generate documentation run: php mwdocgen.php --no-extensions
14 #---------------------------------------------------------------------------
15 # Project related configuration options
16 #---------------------------------------------------------------------------
17 DOXYFILE_ENCODING = UTF-8
18 PROJECT_NAME = MediaWiki
19 PROJECT_NUMBER = {{CURRENT_VERSION}}
22 OUTPUT_DIRECTORY = {{OUTPUT_DIRECTORY}}
24 OUTPUT_LANGUAGE = English
25 BRIEF_MEMBER_DESC = YES
27 ABBREVIATE_BRIEF = "The $name class" \
38 ALWAYS_DETAILED_SEC = NO
39 INLINE_INHERITED_MEMB = NO
41 STRIP_FROM_PATH = {{STRIP_FROM_PATH}}
44 JAVADOC_AUTOBRIEF = YES
46 MULTILINE_CPP_IS_BRIEF = NO
48 SEPARATE_MEMBER_PAGES = NO
50 ALIASES = "type{1}=<b> \1 </b>:" \
51 "types{2}=<b> \1 </b> or <b> \2 </b>:" \
52 "types{3}=<b> \1 </b>, <b> \2 </b>, or <b> \3 </b>:" \
53 "arrayof{2}=<b> Array </b> of \2" \
55 "boolean=\type{Boolean}" \
56 "bool=\type{Boolean}" \
57 "integer=\type{Integer}" \
58 "int=\type{Integer}" \
59 "string=\type{String}" \
61 "mixed=\type{Mixed}" \
62 "access=\par Access:\n" \
63 "private=\access private" \
64 "protected=\access protected" \
65 "public=\access public" \
68 "codeCoverageIgnore=" \
69 "codingStandardsIgnoreStart=" \
73 "expectedException=" \
74 "expectedExceptionMessage="
76 OPTIMIZE_OUTPUT_FOR_C = NO
77 OPTIMIZE_OUTPUT_JAVA = NO
78 OPTIMIZE_FOR_FORTRAN = NO
79 OPTIMIZE_OUTPUT_VHDL = NO
81 MARKDOWN_SUPPORT = YES
82 AUTOLINK_SUPPORT = YES
83 BUILTIN_STL_SUPPORT = NO
86 IDL_PROPERTY_SUPPORT = YES
87 DISTRIBUTE_GROUP_DOC = YES
89 INLINE_GROUPED_CLASSES = NO
90 INLINE_SIMPLE_STRUCTS = NO
91 TYPEDEF_HIDES_STRUCT = NO
93 #---------------------------------------------------------------------------
94 # Build related configuration options
95 #---------------------------------------------------------------------------
100 EXTRACT_LOCAL_CLASSES = YES
101 EXTRACT_LOCAL_METHODS = NO
102 EXTRACT_ANON_NSPACES = NO
103 HIDE_UNDOC_MEMBERS = NO
104 HIDE_UNDOC_CLASSES = NO
105 HIDE_FRIEND_COMPOUNDS = NO
106 HIDE_IN_BODY_DOCS = YES
108 CASE_SENSE_NAMES = YES
109 HIDE_SCOPE_NAMES = NO
110 SHOW_INCLUDE_FILES = YES
111 SHOW_GROUPED_MEMB_INC = NO
112 FORCE_LOCAL_INCLUDES = NO
114 SORT_MEMBER_DOCS = YES
115 SORT_BRIEF_DOCS = YES
116 SORT_MEMBERS_CTORS_1ST = NO
117 SORT_GROUP_NAMES = NO
118 SORT_BY_SCOPE_NAME = NO
119 STRICT_PROTO_MATCHING = NO
120 GENERATE_TODOLIST = YES
121 GENERATE_TESTLIST = YES
122 GENERATE_BUGLIST = YES
123 GENERATE_DEPRECATEDLIST= YES
125 MAX_INITIALIZER_LINES = 30
126 SHOW_USED_FILES = YES
129 FILE_VERSION_FILTER =
132 #---------------------------------------------------------------------------
133 # Configuration options related to warning and progress messages
134 #---------------------------------------------------------------------------
137 WARN_IF_UNDOCUMENTED = YES
138 WARN_IF_DOC_ERROR = YES
139 WARN_NO_PARAMDOC = NO
140 WARN_FORMAT = "$file:$line: $text"
142 #---------------------------------------------------------------------------
143 # Configuration options related to the input files
144 #---------------------------------------------------------------------------
146 INPUT_ENCODING = UTF-8
147 FILE_PATTERNS = *.php \
151 EXCLUDE = {{EXCLUDE}}
152 EXCLUDE_SYMLINKS = YES
153 EXCLUDE_PATTERNS = LocalSettings.php \
161 EXAMPLE_RECURSIVE = NO
163 INPUT_FILTER = "{{INPUT_FILTER}}"
165 FILTER_SOURCE_FILES = NO
166 FILTER_SOURCE_PATTERNS =
167 USE_MDFILE_AS_MAINPAGE =
168 #---------------------------------------------------------------------------
169 # Configuration options related to source browsing
170 #---------------------------------------------------------------------------
173 STRIP_CODE_COMMENTS = YES
174 REFERENCED_BY_RELATION = YES
175 REFERENCES_RELATION = YES
176 REFERENCES_LINK_SOURCE = YES
177 SOURCE_TOOLTIPS = YES
179 VERBATIM_HEADERS = YES
180 #---------------------------------------------------------------------------
181 # Configuration options related to the alphabetical class index
182 #---------------------------------------------------------------------------
183 ALPHABETICAL_INDEX = NO
184 COLS_IN_ALPHA_INDEX = 5
186 #---------------------------------------------------------------------------
187 # Configuration options related to the HTML output
188 #---------------------------------------------------------------------------
191 HTML_FILE_EXTENSION = .html
195 HTML_EXTRA_STYLESHEET =
197 HTML_COLORSTYLE_HUE = 220
198 HTML_COLORSTYLE_SAT = 100
199 HTML_COLORSTYLE_GAMMA = 80
201 HTML_DYNAMIC_SECTIONS = NO
202 HTML_INDEX_NUM_ENTRIES = 100
204 DOCSET_FEEDNAME = "Doxygen generated docs"
205 DOCSET_BUNDLE_ID = org.doxygen.Project
206 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
207 DOCSET_PUBLISHER_NAME = Publisher
208 GENERATE_HTMLHELP = NO
217 QHP_NAMESPACE = org.doxygen.Project
218 QHP_VIRTUAL_FOLDER = doc
219 QHP_CUST_FILTER_NAME =
220 QHP_CUST_FILTER_ATTRS =
221 QHP_SECT_FILTER_ATTRS =
223 GENERATE_ECLIPSEHELP = NO
224 ECLIPSE_DOC_ID = org.doxygen.Project
226 GENERATE_TREEVIEW = YES
227 ENUM_VALUES_PER_LINE = 4
229 EXT_LINKS_IN_WINDOW = NO
230 FORMULA_FONTSIZE = 10
231 FORMULA_TRANSPARENT = YES
233 MATHJAX_FORMAT = HTML-CSS
234 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
238 SERVER_BASED_SEARCH = YES
241 SEARCHDATA_FILE = searchdata.xml
243 EXTRA_SEARCH_MAPPINGS =
244 #---------------------------------------------------------------------------
245 # Configuration options related to the LaTeX output
246 #---------------------------------------------------------------------------
249 LATEX_CMD_NAME = latex
250 MAKEINDEX_CMD_NAME = makeindex
260 LATEX_HIDE_INDICES = NO
261 LATEX_SOURCE_CODE = NO
262 LATEX_BIB_STYLE = plain
263 #---------------------------------------------------------------------------
264 # Configuration options related to the RTF output
265 #---------------------------------------------------------------------------
270 RTF_STYLESHEET_FILE =
271 RTF_EXTENSIONS_FILE =
272 #---------------------------------------------------------------------------
273 # Configuration options related to the man page output
274 #---------------------------------------------------------------------------
275 GENERATE_MAN = {{GENERATE_MAN}}
279 #---------------------------------------------------------------------------
280 # Configuration options related to the XML output
281 #---------------------------------------------------------------------------
284 XML_PROGRAMLISTING = YES
285 #---------------------------------------------------------------------------
286 # Configuration options related to the DOCBOOK output
287 #---------------------------------------------------------------------------
288 GENERATE_DOCBOOK = NO
289 DOCBOOK_OUTPUT = docbook
290 #---------------------------------------------------------------------------
291 # Configuration options for the AutoGen Definitions output
292 #---------------------------------------------------------------------------
293 GENERATE_AUTOGEN_DEF = NO
294 #---------------------------------------------------------------------------
295 # Configuration options related to the Perl module output
296 #---------------------------------------------------------------------------
297 GENERATE_PERLMOD = NO
300 PERLMOD_MAKEVAR_PREFIX =
301 #---------------------------------------------------------------------------
302 # Configuration options related to the preprocessor
303 #---------------------------------------------------------------------------
304 ENABLE_PREPROCESSING = YES
306 EXPAND_ONLY_PREDEF = NO
307 SEARCH_INCLUDES = YES
309 INCLUDE_FILE_PATTERNS =
312 SKIP_FUNCTION_MACROS = YES
313 #---------------------------------------------------------------------------
314 # Configuration options related to external references
315 #---------------------------------------------------------------------------
317 GENERATE_TAGFILE = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
319 EXTERNAL_GROUPS = YES
321 #---------------------------------------------------------------------------
322 # Configuration options related to the dot tool
323 #---------------------------------------------------------------------------
327 HIDE_UNDOC_RELATIONS = YES
328 HAVE_DOT = {{HAVE_DOT}}
330 DOT_FONTNAME = Helvetica
334 COLLABORATION_GRAPH = YES
337 UML_LIMIT_NUM_FIELDS = 10
338 TEMPLATE_RELATIONS = NO
340 INCLUDED_BY_GRAPH = YES
343 GRAPHICAL_HIERARCHY = YES
344 DIRECTORY_GRAPH = YES
345 DOT_IMAGE_FORMAT = png
351 DOT_GRAPH_MAX_NODES = 50
352 MAX_DOT_GRAPH_DEPTH = 1000
354 DOT_MULTI_TARGETS = YES
355 GENERATE_LEGEND = YES